home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 January: Mac OS SDK / Dev.CD Jan 99 SDK1.toast / Development Kits / Apple Guide / Engineering / APISample / APISample - Read Me
Encoding:
Text File  |  1994-12-05  |  2.9 KB  |  71 lines  |  [ttro/ttxt]
  1.            
  2.  
  3. Read Me for APISample
  4.  
  5. APISample is work-in-progress for a demonstration of Apple Guide integration.
  6.  
  7. Versions
  8. ----------
  9.  
  10. There are three versions of APISampleGuide:
  11.  
  12. APISample                                    1.0d3e1    The updated release for the develop issue 18 article.
  13. APISampleCW68K         1.1d1                    Revised for CodeWarrior and compiled for 68K-native.
  14. APISampleCWPPC         1.1d1                 Revised for CodeWarrior and compiled for PowerPC-native. 
  15.  
  16. The CodeWarrior version is still under development and may not be fully functional. Due to a bug in Apple Guide, the APISampleCWPPC version will crash. See the release notes for more information.
  17.  
  18. Installation
  19. ------------
  20.  
  21. The following files are required:
  22.  
  23. APISample—the application.
  24. Assistant—the Apple Guide file for APISample. Place in the same folder as APISample.
  25. System 7.5—Apple Guide is included in the system release.
  26.  
  27. Operation 
  28. -----------
  29.  
  30. Double-click the APISample icon. Use the APISample menu to open the default guide file (Assistant). The Assistant guide file will help you browse APISample and demonstrate its features.
  31.  
  32. Apple Guide Support
  33. ------------------------
  34.  
  35. APISampleGuide uses the standard Apple Guide interface. Current functionality includes:
  36.  
  37. • Sensing the current state of Apple Guide (installed, standby, running, etc.).
  38. • Detecting which “standard” help databases are available (Tutorial, Shortcuts, etc.).
  39. • Telling Apple Guide to startup with the default database or any specified database.
  40. • Responding to dynamic coach-marking events.
  41. • Responding to context-check events.
  42. • Receiving events from Apple Guide.
  43. • Sending events to Apple Guide.
  44. • Finding Apple Guide databases, determining their type, and opening them.
  45.  
  46. Building APISample
  47. ------------------------------
  48.  
  49. The source code for APISample is available on the develop Bookmark CD and on the Developer Reference Library CD.
  50.  
  51. TApplication and TDocument are built separately and are included as libraries in the build of APISample. They were copied without change from MPW CPlusExamples (ETO #8 or newer). They should not need rebuilding.  TApplication and TDocument were removed for the CodeWarrior version.
  52.  
  53. If you are building the CodeWarrior projects you will need to set an access path to where your MPW Universal Headers so the compiler can find the file 'PLStringFuncs.h' correctly.  The path found in the sample CW projects will undoubtedly be incorrect for your build environment.
  54.  
  55. To build APISample: 
  56.  
  57. 1. Set the directory path to the folder containing the APISample files. 
  58.  
  59. 2. Enter “BuildProgram APISample.”  (See APISample.make for more information.)
  60.  
  61. The Assistant database is already built. Source is provided, but you will need the Apple Guide authoring tool to compile it.
  62.  
  63. For more information
  64. ----------------------------
  65.  
  66. Please direct your questions and comments to Applelink: AUTHOR.GUIDE
  67.  
  68. ©1994 Apple Computer, Inc.
  69.  
  70. Apple, the Apple logo, and Macintosh are trademarks of Apple Computer, Inc., registered in the U.S.A. and other countries.
  71.